---
title: clsAwardBenefitPayment
summary: API reference for clsAwardBenefitPayment.
status: draft
owner: SAIF Documentation Generator
last_reviewed: 2026-08-21
library: SAIF.Business.Claim
reference_type: embedded
---

# clsAwardBenefitPayment

`clsAwardBenefitPayment` owns a single benefit-payment row scoped to an award and restricted to benefit status `'2'` (In Progress), supporting retrieval, update of the issue date, and deletion.

## Purpose
- Retrieves, updates, and deletes an award-scoped benefit-payment row ([SQL-014](../../sql/SQL-014.md), [SQL-040](../../sql/SQL-040.md), [SQL-055](../../sql/SQL-055.md)).
- Restricts retrieval to rows with `BENEFIT_STATUS_CODE = '2'`, so only in-progress payments are visible through this object.*

## Context
- Namespace: `SAIF.Business.Claim`
- Assembly/package: `SAIF.Business.Claim.dll`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `Criteria.RetrieveSQL` | `ReadOnly Property RetrieveSQL As String` | Retrieves the in-progress benefit-payment row for a claim/award ([SQL-014](../../sql/SQL-014.md)). |
| `Criteria.UpdateSQL` | `ReadOnly Property UpdateSQL As String` | Updates the payment's issue date, guarded by optimistic concurrency ([SQL-040](../../sql/SQL-040.md)). |
| `Criteria.DeleteSQL` | `ReadOnly Property DeleteSQL As String` | Deletes the payment row, guarded by optimistic concurrency ([SQL-055](../../sql/SQL-055.md). |

## Behavioral notes
- DB-contention errors are raised via `After*` hooks when `RowsAffected <> 1` ([BR-012](../../business-rules.md#br-012-optimistic-concurrency-contention-check)).

## Constraints and usage notes
- Only benefit-status `'2'` rows are retrievable through this type; other statuses require a different business object.

> **Note:** Statements marked with * were inferred from code structure, naming conventions, or
> contextual evidence where direct confirmation was not available in source artifacts. Statements
> marked with ** could not be confirmed; treat as unknown until verified.

## Related documentation
- [Library index](../../index.md)
- [API reference index](../index.md)
- [Overview](../../overview.md)
- [Architecture](../../architecture.md)
- [Dependencies](../../dependencies.md)
- [Operations and processes](../../operations-processes.md)
- [Business rules](../../business-rules.md)
- [Database tables](../../database-tables.md)
- [SQL catalog](../../sql/index.md)
## Sources
- SAIF.Business.Claim/clsAwardBenefitPayment.vb